Executor框架

发表于 更新于 分类于
本文字数： 29k 阅读时长 ≈ 26 分钟
介绍Java中线程池，包括：Executor框架的两级调度模型、结构与成员、ThreadPoolExecutor详解、ScheduledThreadPoolExecutor详解、FutureTask详解等。

Executor框架

一. 简介

从JDK1.5开始，Java API提供了Executor框架来创建线程池，管理和控制多线程任务执行。

在Java中，使用线程来异步执行任务。Java线程的创建与销毁需要一定的开销，如果我们为每一个任务创建一个新线程来执行，这些线程的创建与销毁将消耗大量的计算资源。同时，为每一个任务创建一个新线程来执行，这种策略可能会使处于高负荷状态的应用最终崩溃。

Java的线程既是工作单元，也是执行机制。从JDK 5开始，把工作单元与执行机制分离开来。工作单元包括Runnable和Callable，而执行机制由Executor框架提供。

1.1 两级调度模型

在HotSpot VM的线程模型中，Java线程（java.lang.Thread）被一对一映射为本地操作系统线程。Java线程启动时会创建一个本地操作系统线程；当该Java线程终止时，这个操作系统线程也会被回收。操作系统会调度所有线程并将它们分配给可用的CPU。

在上层，Java多线程程序通常把应用分解为若干个任务，然后使用用户级的调度器 （Executor框架）将这些任务映射为固定数量的线程；在底层，操作系统内核将这些线程映射到 硬件处理器上。这种两级调度模型的示意图如下图所示。

任务的两级调度模型

从图中可以看出，应用程序通过Executor框架控制上层的调度，而下层的调度由操作系统内核控制，下层的调度不受应用程序的控制。

1.2 结构与成员

本文将分两部分来介绍Executor：Executor的结构和Executor框架包含的成员组件。

1.2.1 结构

Executor框架主要由3大部分组成如下：

  • 任务：包括被执行任务需要实现的接口：Runnable接口或Callable接口。
  • 任务的执行：包括任务执行机制的核心接口Executor，以及继承自Executor的ExecutorService接口。Executor框架有两个关键类实现了ExecutorService接口 （ThreadPoolExecutor和ScheduledThreadPoolExecutor）。
  • 异步计算的结果：包括接口Future和实现Future接口的FutureTask类。Executor框架包含的主要的类与接口如图所示。下面是这些类和接口的简介。

代码结构：

  • Executor是一个接口，它是Executor框架的基础，它将任务的提交与任务的执行分离开来。它会接收一个 Runnable 任务，并决定如何在某个线程中执行该任务。

    1
    2
    3
    public interface Executor {
        void execute(Runnable command);
    }

  • ExecutorService扩展了Executor，提供了一些更高级的线程池管理功能，如管理线程生命周期、提交异步任务等。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    public interface ExecutorService extends Executor {
        
        // 关闭线程池，已提交的任务继续执行，但不接受新任务。
        void shutdown();

        // 立即停止正在运行的任务并关闭线程池
        List<Runnable> shutdownNow();

        boolean isShutdown();

        boolean isTerminated();

        boolean awaitTermination(long timeout, TimeUnit unit)
            throws InterruptedException;

        // 提交任务，返回 Future
        <T> Future<T> submit(Callable<T> task);

        <T> Future<T> submit(Runnable task, T result);

        Future<?> submit(Runnable task);

        // 批量提交多个任务，返回多个结果或其中一个结果
        <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks)
            throws InterruptedException;

        <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks,
                                      long timeout, TimeUnit unit)
            throws InterruptedException;

        <T> T invokeAny(Collection<? extends Callable<T>> tasks)
            throws InterruptedException, ExecutionException;

        <T> T invokeAny(Collection<? extends Callable<T>> tasks,
                        long timeout, TimeUnit unit)
            throws InterruptedException, ExecutionException, TimeoutException;
    }

  • ScheduledExecutorService用于调度任务的执行，支持定时执行或周期性执行。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    public interface ScheduledExecutorService extends ExecutorService {

        // 延迟一定时间执行任务
        public ScheduledFuture<?> schedule(Runnable command,
                                           long delay, TimeUnit unit);

        public <V> ScheduledFuture<V> schedule(Callable<V> callable,
                                               long delay, TimeUnit unit);

        // 按照固定的时间间隔周期性执行任务
        public ScheduledFuture<?> scheduleAtFixedRate(Runnable command,
                                                      long initialDelay,
                                                      long period,
                                                      TimeUnit unit);

        // 在任务之间保持固定延迟的周期性执行任务
        public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command,
                                                         long initialDelay,
                                                         long delay,
                                                         TimeUnit unit);
    }

  • ThreadPoolExecutor是线程池的核心实现类，用来执行被提交的任务。可以通过线程池来管理大量并发任务。

  • ScheduledThreadPoolExecutor是一个实现类，可以在给定的延迟后运行命令，或者定期执行命令。ScheduledThreadPoolExecutor比Timer更灵活，功能更强大。

  • Future接口和实现Future接口的FutureTask类，代表异步计算的结果，可以通过 Future 来获取任务的执行状态和结果。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17

    public interface Future<V> {

        // 取消任务执行
        boolean cancel(boolean mayInterruptIfRunning);

        boolean isCancelled();

        // 判断任务是否已经完成
        boolean isDone();

        // 获取任务执行结果，会阻塞直到任务完成。
        V get() throws InterruptedException, ExecutionException;

        V get(long timeout, TimeUnit unit)
            throws InterruptedException, ExecutionException, TimeoutException;
    }

  • Runnable接口和Callable接口的区别主要在如何处理任务的返回值和异常。Runnable无返回值也不抛出异常。Callable则适用于需要返回值的任务，且可以抛出异常。所以当通过ExecutorService.submit(Runnable task)提交任务后Future.get()无返回值，而ExecutorService.submit(Callable task)则有。Runnable接口和Callable接口的实现类，都可以被ThreadPoolExecutor或ScheduledThreadPoolExecutor执行。

    1
    2
    3
    4
    5
    6
    7
    8
    9
    public interface Runnable {
        
        public abstract void run();
    }

    public interface Callable<V> {
        
        V call() throws Exception;
    }

Executor框架的使用示意图如下图所示。

Executor框架的类与接口

Executor框架的使用示意图

  • 主线程首先要创建实现Runnable或者Callable接口的任务对象。工具类Executors可以把一个Runnable对象封装为一个Callable对象：Executors.callable(Runnable task) 或 Executors.callable(Runnable task, Object resule) 。
  • 然后可以把Runnable对象直接交给ExecutorService执行 ExecutorService.execute(Runnable command) ；或者也可以把Runnable对象或Callable对象提交给ExecutorService执行 ExecutorService.submit(Runnable task) 或 ExecutorService.submit(Callable<T> task) 。
  • 如果执行 ExecutorService.submit(…) ，ExecutorService将返回一个实现Future接口的对象 （到目前为止的JDK中，返回的是FutureTask对象）。由于FutureTask实现了Runnable，程序员也可以创建FutureTask，然后直接交给ExecutorService执行。
  • 最后，主线程可以执行 FutureTask.get() 方法来等待任务执行完成。主线程也可以执行 FutureTask.cancel(boolean mayInterruptIfRunning) 来取消此任务的执行。

1.2.2 成员

本节将介绍Executor框架的主要成员：ThreadPoolExecutor、ScheduledThreadPoolExecutor、Future接口、Runnable接口、Callable接口和Executors。

（1）ThreadPoolExecutor

ThreadPoolExecutor通常使用工厂类Executors来创建。Executors可以创建3种类型的ThreadPoolExecutor：

  • SingleThreadExecutor：使用单个线程，适用于需要保证顺序地执行各个任务；并且在任意时间点，不会有多个线程是活动的应用场景。

    1
    2
    public static ExecutorService newSingleThreadExecutor() 
    public static ExecutorService newSingleThreadExecutor(ThreadFactory threadFactory)

  • FixedThreadPool：使用固定线程数，适用于为了满足资源管理的需求，而需要限制当前线程数量的应用场景，它适用于负载比较重的服务器。

    1
    2
    public static ExecutorService newFixedThreadPool(int nThreads) 
    public static ExecutorService newFixedThreadPool(int nThreads, ThreadFactorythreadFactory)

  • CachedThreadPool：会根据需要创建新线程，CachedThreadPool是大小无界的线程池，适用于执行很多的短期异步任务的小程序，或者是负载较轻的服务器。

    1
    2
    public static ExecutorService newCachedThreadPool() 
    public static ExecutorService newCachedThreadPool(ThreadFactory threadFactory)
（2）ScheduledThreadPoolExecutor

ScheduledThreadPoolExecutor通常使用工厂类Executors来创建。Executors可以创建2种类型的ScheduledThreadPoolExecutor，如下：

  • ScheduledThreadPoolExecutor：创建固定个数线程。适用于需要多个后台线程执行周期任务，同时为了满足资源管理的需求而需要限制后台线程的数量的应用场景。

    1
    2
    public static ScheduledExecutorService newScheduledThreadPool(int corePoolSize) 
    public static ScheduledExecutorService newScheduledThreadPool(int corePoolSize,ThreadFaScheduledThreadPoolExecutor

  • SingleThreadScheduledExecutor。只包含一个线程。适用于需要单个后台线程执行周期任务，同时需要保证顺序地执行各个任务的应用场景。

    1
    2
    public static ScheduledExecutorService newSingleThreadScheduledExecutor() 
    public static ScheduledExecutorService newSingleThreadScheduledExecutor (ThreadFactory threadFactory)
（3）Future接口

Future接口和实现Future接口的FutureTask类用来表示异步计算的结果。当我们把Runnable接口或Callable接口的实现类提交（submit）给ThreadPoolExecutor或ScheduledThreadPoolExecutor时，ThreadPoolExecutor或ScheduledThreadPoolExecutor会向我们返回一个FutureTask对象。下面是对应的API。

1
2
3
<T> Future<T> submit(Callable<T> task) 
<T> Future<T> submit(Runnable task, T result) 
Future<> submit(Runnable task)

有一点需要注意，到目前最新的JDK 8为止，Java通过上述API返回的是一个FutureTask对象。但从API可以看到，Java仅仅保证返回的是一个实现了Future接口的对象。在将来的JDK实现中，返回的可能不一定是FutureTask。

（4）Runnable接口和Callable接口

Runnable接口和Callable接口的实现类，都可以被ThreadPoolExecutor或ScheduledThreadPoolExecutor执行。它们之间的区别是Runnable不会返回结果，而Callable可以返回结果。除了可以自己创建实现Callable接口的对象外，还可以使用工厂类Executors来把一个 Runnable包装成一个Callable。

下面是Executors提供的，把一个Runnable包装成一个Callable的API。

1
public static Callable<Object> callable(Runnable task)        // 假设返回对象Callable1

下面是Executors提供的，把一个Runnable和一个待返回的结果包装成一个Callable的API。

1
public static <T> Callable<T> callable(Runnable task, T result)      // 假设返回对象Callable2

前面讲过，当我们把一个Callable对象（比如上面的Callable1或Callable2）提交给ThreadPoolExecutor或ScheduledThreadPoolExecutor执行时，submit（…）会向我们返回一个FutureTask对象。我们可以执行FutureTask.get()方法来等待任务执行完成。当任务成功完成后 FutureTask.get()将返回该任务的结果。例如，如果提交的是对象Callable1，FutureTask.get()方法将返回null；如果提交的是对象Callable2，FutureTask.get()方法将返回result对象。

二. ThreadPoolExecutor详解

Executor框架最核心的类是ThreadPoolExecutor，它是线程池的实现类，主要由下列4个组件构成：

  • corePool：核心线程池的大小。
  • maximumPool：最大线程池的大小。
  • BlockingQueue：用来暂时保存任务的工作队列。
  • RejectedExecutionHandler：当ThreadPoolExecutor已经关闭或ThreadPoolExecutor已经饱和时（达到了最大线程池大小且工作队列已满），execute() 方法将要调用的Handler。

通过Executor框架的工具类Executors，可以创建3种类型的ThreadPoolExecutor：

  • FixedThreadPool。
  • SingleThreadExecutor。
  • CachedThreadPool。

下面将分别介绍这3种ThreadPoolExecutor。其构造函数如下：keepAliveTime表示为多余的空闲线程等待新任务的最长时间，超过这个时间后多余的线程将被终止。

1
2
3
4
5
6
7
8
9
public ThreadPoolExecutor(int corePoolSize,
                             int maximumPoolSize,
                             long keepAliveTime,
                             TimeUnit unit,
                             BlockingQueue<Runnable> workQueue,
                             ThreadFactory threadFactory) {
       this(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue,
            threadFactory, defaultHandler);
   }

2.1 FixedThreadPool详解

FixedThreadPool被称为可重用固定线程数的线程池。下面是FixedThreadPool的源代码实现。

1
2
3
public static ExecutorService newFixedThreadPool(int nThreads) {    
    return new ThreadPoolExecutor(nThreads, nThreads, 0L, TimeUnit.MILLISECONDS,new LinkedBlockingQueue<Runnable>()); 
}

FixedThreadPool的corePoolSize和maximumPoolSize都被设置为创建FixedThreadPool时指定的参数nThreads。当线程池中的线程数大于corePoolSize时，keepAliveTime为多余的空闲线程等待新任务的最长时间，超过这个时间后多余的线程将被终止。这里把keepAliveTime设置为0L，意味着多余的空闲线程会被立即终止。

FixedThreadPool的execute()方法的运行示意图如下图所示。

FixedThreadPool的execute()的运行示意图

对此图的说明如下。

  1. 如果当前运行的线程数少于corePoolSize，则创建新线程来执行任务。
  2. 在线程池完成预热之后（当前运行的线程数等于corePoolSize），将任务加入 LinkedBlockingQueue。
  3. 线程执行完1中的任务后，会在循环中反复从LinkedBlockingQueue获取任务来执行。FixedThreadPool使用无界队列LinkedBlockingQueue作为线程池的工作队列（队列的容量为 Integer.MAX_VALUE）。

使用无界队列作为工作队列会对线程池带来如下影响。

  1. 当线程池中的线程数达到corePoolSize后，新任务将在无界队列中等待，因此线程池中的线程数不会超过corePoolSize。
  2. 由于1，使用无界队列时maximumPoolSize将是一个无效参数。
  3. 由于1和2，使用无界队列时keepAliveTime将是一个无效参数。
  4. 由于使用无界队列，运行中的FixedThreadPool（未执行方法 shutdown() 或 shutdownNow() ）不会拒绝任务（不会调用 RejectedExecutionHandler.rejectedExecution 方法）。

2.2 SingleThreadExecutor详解

SingleThreadExecutor是使用单个worker线程的Executor。下面是SingleThreadExecutor的源代码实现。

1
2
3
public static ExecutorService newSingleThreadExecutor() {    
    return new FinalizableDelegatedExecutorService(new ThreadPoolExecutor(1, 1, 0L, TimeUnit.MILLISECONDS,                                                                               new LinkedBlockingQueue<Runnable>())); 
}

SingleThreadExecutor的corePoolSize和maximumPoolSize被设置为1。其他参数与 FixedThreadPool相同。SingleThreadExecutor使用无界队列LinkedBlockingQueue作为线程池的工作队列（队列的容量为Integer.MAX_VALUE）。SingleThreadExecutor使用无界队列作为工作队列对线程池带来的影响与FixedThreadPool相同，这里就不赘述了。

SingleThreadExecutor的运行示意图如下图所示。

SingleThreadExecutor的execute()的运行示意图

对上图的说明如下。

  1. 如果当前运行的线程数少于corePoolSize（即线程池中无运行的线程），则创建一个新线程来执行任务。
  2. 在线程池完成预热之后（当前线程池中有一个运行的线程），将任务加入LinkedBlockingQueue。
  3. 线程执行完1中的任务后，会在一个无限循环中反复从LinkedBlockingQueue获取任务来执行。

2.3 CachedThreadPool

CachedThreadPool则核心线程池为空，并且无限大，线程最长空闲存货时间为60s，任务队列为SynchronousQueue。

1
2
3
4
5
public static ExecutorService newCachedThreadPool() {
       return new ThreadPoolExecutor(0, Integer.MAX_VALUE,
                                     60L, TimeUnit.SECONDS,
                                     new SynchronousQueue<Runnable>());
   }

CachedThreadPool的execute()的运行示意图

对上图的说明如下。

  1. 首先执行 SynchronousQueue.offer(Runnable task) 。如果当前maximumPool中有空闲线程正在执行 SynchronousQueue.poll(keepAliveTime, TimeUnit.NANOSECONDS) ，那么主线程执行offer操作与空闲线程执行的poll操作配对成功，主线程把任务交给空闲线程执行，execute()方法执行完成；否则执行下面的步骤2）。
  2. 当初始maximumPool为空，或者maximumPool中当前没有空闲线程时，将没有线程执行 SynchronousQueue.poll(keepAliveTime, TimeUnit.NANOSECONDS) 。这种情况下，步骤1将失败。此时CachedThreadPool会创建一个新线程执行任务，execute()方法执行完成。
  3. 在步骤2中新创建的线程将任务执行完后，会执行 SynchronousQueue.poll(keepAliveTime, TimeUnit.NANOSECONDS) 。这个poll操作会让空闲线程最多在SynchronousQueue中等待60秒钟。如果60秒钟内主线程提交了一个新任务（主线程执行步骤1），那么这个空闲线程将执行主线程提交的新任务；否则，这个空闲线程将终止。由于空闲60秒的空闲线程会被终止，因此长时间保持空闲的CachedThreadPool不会使用任何资源。

前面提到过，SynchronousQueue是一个没有容量的阻塞队列。每个插入操作必须等待另一个线程的对应移除操作，反之亦然。CachedThreadPool使用SynchronousQueue，把主线程提交的任务传递给空闲线程执行。CachedThreadPool中任务传递的示意图如下图所示。

CachedThreadPool的任务传递示意图

三. ScheduledThreadPoolExecutor详解

ScheduledThreadPoolExecutor继承自ThreadPoolExecutor。它主要用来在给定的延迟之后运行任务，或者定期执行任务。ScheduledThreadPoolExecutor的功能与Timer类似，但ScheduledThreadPoolExecutor功能更强大、更灵活。Timer对应的是单个后台线程，而 ScheduledThreadPoolExecutor可以在构造函数中指定多个对应的后台线程数。

3.1 运行机制

ScheduledThreadPoolExecutor的执行示意图（本文基于JDK 6）如下图所示。DelayQueue是一个无界队列，所以ThreadPoolExecutor的maximumPoolSize在ScheduledThreadPoolExecutor中没有什么意义（设置maximumPoolSize的大小没有什么效果）。

ScheduledThreadPoolExecutor的任务传递示意图

ScheduledThreadPoolExecutor的执行主要分为两大部分。

  1. 当调用ScheduledThreadPoolExecutor的 scheduleAtFixedRate() 方法或者 scheduleWithFixedDelay() 方法时，会向ScheduledThreadPoolExecutor的DelayQueue添加一个实现了RunnableScheduledFutur接口的ScheduledFutureTask。
  2. 线程池中的线程从DelayQueue中获取ScheduledFutureTask，然后执行任务。

ScheduledThreadPoolExecutor为了实现周期性的执行任务，对ThreadPoolExecutor做了如下的修改：

  • 使用DelayQueue作为任务队列。
  • 获取任务的方式不同（后文会说明）。
  • 执行周期任务后，增加了额外的处理（后文会说明）。

3.2 实现

前面我们提到过，ScheduledThreadPoolExecutor会把待调度的任务（ScheduledFutureTask）放到一个DelayQueue中。

ScheduledFutureTask主要包含3个成员变量，如下。

  • long型成员变量time，表示这个任务将要被执行的具体时间。
  • long型成员变量sequenceNumber，表示这个任务被添加到ScheduledThreadPoolExecutor中的序号。
  • long型成员变量period，表示任务执行的间隔周期。

DelayQueue封装了一个PriorityQueue，这个PriorityQueue会对队列中的ScheduledFutureTask进行排序。排序时，time小的排在前面（时间早的任务将被先执行）。如果两个ScheduledFutureTask的time相同，就比较sequenceNumber，sequenceNumber小的排在前面（也就是说，如果两个任务的执行时间相同，那么先提交的任务将被先执行）。

首先，让我们看看ScheduledThreadPoolExecutor中的线程执行周期任务的过程。下图是ScheduledThreadPoolExecutor中的线程1执行某个周期任务的4个步骤。

ScheduledThreadPoolExecutor的任务执行步骤

下面是对这4个步骤的说明。

  1. 线程1从DelayQueue中获取已到期的ScheduledFutureTask( DelayQueue.take() ) 。到期任务是指ScheduledFutureTask的time大于等于当前时间。
  2. 线程1执行这个ScheduledFutureTask。
  3. 线程1修改ScheduledFutureTask的time变量为下次将要被执行的时间。
  4. 线程1把这个修改time之后的ScheduledFutureTask放回DelayQueue中（ DelayQueue.add() ）。

接下来，让我们看看上面的步骤1获取任务的过程。下面是 DelayQueue.take() 方法的源代码实现。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public E take() throws InterruptedException {    
    final ReentrantLock lock = this.lock;    
    lock.lockInterruptibly();　　　　　　　　　　　　          
    // 1    
    try {        
        for (;;) {            
            E first = q.peek();            
            if (first == null) {                
                available.await();　　　　　　　　　　         
                // 2.1            
            } else {                
                long delay =  first.getDelay(TimeUnit.NANOSECONDS);                
                if (delay > 0) {                    
                    long tl = available.awaitNanos(delay);　　 
                    // 2.2                
                } else {                    
                    E x = q.poll();　　　　　　　　　　        
                    // 2.3.1                    
                    assert x != null;                    
                    if (q.size() != 0)                        
                        available.signalAll();　　　　　　　　 
                    // 2.3.2                    
                    return x;                
                }            
            }        
        }    
    } finally {        
        lock.unlock();　　　　　　　　　　　　　　              
        // 3    
    } 
}

下图是DelayQueue.take()的执行示意图。

ScheduledThreadPoolExecutor获取任务的过程

如图所示，获取任务分为3大步骤。

  1. 获取Lock。
  2. 获取周期任务。
    • 如果PriorityQueue为空，当前线程到Condition中等待；否则执行下面的2.2。
    • 如果PriorityQueue的头元素的time时间比当前时间大，到Condition中等待到time时间；否 则执行下面的2.3。
    • 获取PriorityQueue的头元素（2.3.1）；如果PriorityQueue不为空，则唤醒在Condition中等待的所有线程（2.3.2）。
  3. 释放Lock。

ScheduledThreadPoolExecutor在一个循环中执行步骤2，直到线程从PriorityQueue获取到一个元素之后（执行2.3.1之后），才会退出无限循环（结束步骤2）。

最后，让我们看看ScheduledThreadPoolExecutor中的线程执行任务的步骤4，把ScheduledFutureTask放入DelayQueue中的过程。下面是 DelayQueue.add() 的源代码实现。

1
2
3
4
5
6
7
8
9
10
11
12
13
public boolean offer(E e) {    
    final ReentrantLock lock = this.lock;    
    lock.lock();　// 1    
    try {        
        E first = q.peek();        
        q.offer(e);　// 2.1        
        if (first == null || e.compareTo(first) < 0)            
            available.signalAll();　// 2.2        
        return true;    
    } finally {        
        lock.unlock();　// 3    
    } 
}

下图是 DelayQueue.add() 的执行示意图。

ScheduledThreadPoolExecutor添加任务的过程

如图所示，添加任务分为3大步骤。

  1. 获取Lock。
  2. 添加任务。
    • 向PriorityQueue添加任务。
    • 如果在上面2.1中添加的任务是PriorityQueue的头元素，唤醒在Condition中等待的所有线程。
  3. 释放Lock。

四. Future和FutureTask详解

Future接口和实现Future接口的FutureTask类，代表异步计算的结果。

4.1 Future接口

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
public interface Future<V> {

    /**
     * 尝试取消执行此任务，若任务已完成、已取消或其他原因无法取消则此尝试失败。若执行成功，且执行时任务尚未启动，则此任务不会再运行。若任务已启动，则mayInterruptIfRunning来决定是否中断其执行
     */
    boolean cancel(boolean mayInterruptIfRunning);

    /**
     * 若任务在正常完成前被取消则返回true
     */
    boolean isCancelled();

    /**
     * 若任务执行完毕则返回true
     */
    boolean isDone();

    /**
     * 等待计算完成，并返回结果
     */
    V get() throws InterruptedException, ExecutionException;

    /**
     * 等待最多指定的时间来完成计算，返回结果
     */
    V get(long timeout, TimeUnit unit)
        throws InterruptedException, ExecutionException, TimeoutException;
}

Future的 get() 方法是阻塞性的，当计算尚未结束时 get() 方法会一直阻塞，所以就导致了排队等待，严重的影响到运行效率。RunnableFuture 表示一种任务，既可以作为 Runnable 被线程执行，又可以作为 Future 获取任务的结果或状态。

1
2
3
4
5
6
public interface RunnableFuture<V> extends Runnable, Future<V> {
    /**
     * 设置此Future为计算结果，除非被取消
     */
    void run();
}

使用：

1
2
3
4
5
6
7
8
9
10
11
12
13
ExecutorService executor = Executors.newFixedThreadPool(2);
Future<Integer> future = executor.submit(() -> {
    // 模拟耗时任务
    Thread.sleep(2000);
    return 42;
});

try {
    Integer result = future.get();  // 阻塞直到任务完成，获取结果
    System.out.println(result);
} catch (InterruptedException | ExecutionException e) {
    e.printStackTrace();
}

4.2 FutureTask实现类

FutureTask除了实现Future接口外，还实现了Runnable接口。因此，FutureTask可以交给 Executor执行，也可以由调用线程直接执行（ FutureTask.run() ）。根据 FutureTask.run() 方法被执行的时机，FutureTask可以处于下面3种状态：

  1. 未启动。FutureTask.run() 方法还没有被执行之前，FutureTask处于未启动状态。当创建一个FutureTask，且没有执行 FutureTask.run() 方法之前，这个FutureTask处于未启动状态。
  2. 已启动。FutureTask.run() 方法被执行的过程中，FutureTask处于已启动状态。
  3. 已完成。FutureTask.run() 方法执行完后正常结束，或被取消（ FutureTask.cancel(…) ），或执行 FutureTask.run() 方法时抛出异常而异常结束，FutureTask处于已完成状态。

下图是FutureTask的状态迁移的示意图。

FutureTask的状态迁移示意图

  • 当FutureTask处于未启动或已启动状态时，执行 FutureTask.get() 方法将导致调用线程阻塞；
  • 当FutureTask处于已完成状态时，执行 FutureTask.get() 方法将导致调用线程立即返回结果或抛出异常。
  • 当FutureTask处于未启动状态时，执行 FutureTask.cancel() 方法将导致此任务永远不会被执行；
  • 当FutureTask处于已启动状态时，执行 FutureTask.cancel(true) 方法将以中断执行此任务线程的方式来试图停止任务；
  • 当FutureTask处于已启动状态时，执行 FutureTask.cancel(false) 方法将不会对正在执行此任务的线程产生影响（让正在执行的任务运行完成）；
  • 当FutureTask处于已完成状态时，执行 FutureTask.cancel(…) 方法将返回false。

下图是get方法和cancel方法的执行示意图。

FutureTask的get和cancel的执行示意图

FutureTask 是 Future 的一个具体实现类，除了作为任务的结果容器外，它也实现了 Runnable，因此可以直接提交给 ExecutorService 或者在 Thread 中执行。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
/**
 * 可被取消的异步运算
 * 此类为接口Future的实现类，实现了启动和取消计算，查询计算是否完成以及查询计算结果等方法。
 * 只有在计算完成后才能检索结果，在此之前get()会一直阻塞。计算完成后无法重新启动或者取消计算。
 */
public class FutureTask<V> implements RunnableFuture<V> {
    /*
     * 修订说明：当前与该类以前依赖AbstractQueuedSynchronizer的版本不同，主要是为了避免在取消竞争期间保留中断状态使用户觉得诧异。当前设计中的同步控制依赖于通过CAS更新的“状态”字段来跟踪完成情况，以及一个简单的treiber堆栈来保存等待的线程。
     *
     * 样式说明：和往常一样，我们绕过使用atomicxfieldupdater的开销，而是直接使用不安全的内部函数。
     */

    /**
     * 当前任务的执行状态，初始为NEW.  只会在set,setException,cancel中转为终止状态，
     * 在过程中可能会有临时的状态：
     *   COMPLETING (在设置结果时) 和 INTERRUPTING (仅在中断程序以便cancel(true)时)
     * 这些状态转变采用比较廉价的ordered/lazy写入，因为这些值都是唯一的，无法被修改。
     * 可能发生的状态转换:
     * NEW -> COMPLETING -> NORMAL
     * NEW -> COMPLETING -> EXCEPTIONAL
     * NEW -> CANCELLED
     * NEW -> INTERRUPTING -> INTERRUPTED
     */
    private volatile int state;
    private static final int NEW          = 0;
    private static final int COMPLETING   = 1;
    private static final int NORMAL       = 2;
    private static final int EXCEPTIONAL  = 3;
    private static final int CANCELLED    = 4;
    private static final int INTERRUPTING = 5;
    private static final int INTERRUPTED  = 6;

    /** 底层可调用，运行后为null */
    private Callable<V> callable;
    /** 返回的结果或get()抛出的异常 */
    private Object outcome; // non-volatile, protected by state reads/writes
    /** 运行callable的thread，在run()进行了CAS */
    private volatile Thread runner;
    /** 等待线程的treiber堆栈 */
    private volatile WaitNode waiters;

    /**
     * 返回已完成任务的结果
     */
    @SuppressWarnings("unchecked")
    private V report(int s) throws ExecutionException {
        Object x = outcome;
        if (s == NORMAL)
            return (V)x;
        if (s >= CANCELLED)
            throw new CancellationException();
        throw new ExecutionException((Throwable)x);
    }

    /**
     * 创建FutureTask}在运行时执行给定的Callable
     */
    public FutureTask(Callable<V> callable) {
        if (callable == null)
            throw new NullPointerException();
        this.callable = callable;
        this.state = NEW;       // 确保callable的可见性
    }

    /**
     * 创建FutureTask}在运行时执行给定的Callable，并在get()成功结束后返回给定的结果
     */
    public FutureTask(Runnable runnable, V result) {
        this.callable = Executors.callable(runnable, result);
        this.state = NEW;       // ensure visibility of callable
    }

    public boolean isCancelled() {
        return state >= CANCELLED;
    }

    public boolean isDone() {
        return state != NEW;
    }

    public boolean cancel(boolean mayInterruptIfRunning) {
        if (!(state == NEW &&
              UNSAFE.compareAndSwapInt(this, stateOffset, NEW,
                  mayInterruptIfRunning ? INTERRUPTING : CANCELLED)))
            return false;
        try {    // in case call to interrupt throws exception
            if (mayInterruptIfRunning) {
                try {
                    Thread t = runner;
                    if (t != null)
                        t.interrupt();
                } finally { // final state
                    UNSAFE.putOrderedInt(this, stateOffset, INTERRUPTED);
                }
            }
        } finally {
            finishCompletion();
        }
        return true;
    }

    public V get() throws InterruptedException, ExecutionException {
        int s = state;
        if (s <= COMPLETING)
            s = awaitDone(false, 0L);
        return report(s);
    }

    public V get(long timeout, TimeUnit unit)
        throws InterruptedException, ExecutionException, TimeoutException {
        if (unit == null)
            throw new NullPointerException();
        int s = state;
        if (s <= COMPLETING &&
            (s = awaitDone(true, unit.toNanos(timeout))) <= COMPLETING)
            throw new TimeoutException();
        return report(s);
    }

    /**
     * 当任务转换为状态isDone(正常流程或cancel()取消)时调用此方法，默认实现什么也不做，子类可以重写此函数来进行回调或执行记录。
     * 可以在函数内查询当前状态，来确定是否已取消此任务。
     */
    protected void done() { }

    /**
     * 设置future的结果为给定值，除非此future已被set或已被cancel
     * 此方法会在完成计算后被run()内部调用
     */
    protected void set(V v) {
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = v;
            UNSAFE.putOrderedInt(this, stateOffset, NORMAL); // final state
            finishCompletion();
        }
    }

    /**
     * 使此future声明一个ExecutionException，并将给定的Throwable作为原因，除非此future已被set或已被cancel
     * 此方法会在完成计算失败时被run()内部调用
     */
    protected void setException(Throwable t) {
        if (UNSAFE.compareAndSwapInt(this, stateOffset, NEW, COMPLETING)) {
            outcome = t;
            UNSAFE.putOrderedInt(this, stateOffset, EXCEPTIONAL); // final state
            finishCompletion();
        }
    }

    public void run() {
        if (state != NEW ||
            !UNSAFE.compareAndSwapObject(this, runnerOffset,
                                         null, Thread.currentThread()))
            return;
        try {
            Callable<V> c = callable;
            if (c != null && state == NEW) {
                V result;
                boolean ran;
                try {
                    result = c.call();
                    ran = true;
                } catch (Throwable ex) {
                    result = null;
                    ran = false;
                    setException(ex);
                }
                if (ran)
                    set(result);
            }
        } finally {
            // runner must be non-null until state is settled to
            // prevent concurrent calls to run()
            runner = null;
            // state must be re-read after nulling runner to prevent
            // leaked interrupts
            int s = state;
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
    }

    /**
     * 在不设置结果的情况下进行计算，然后将此future设置为初始状态。若计算遇到异常或被cancel，则无法执行此操作。
     * 为了同本质上会执行多次的任务一起执行而设计，成功运行并重置则返回true
     */
    protected boolean runAndReset() {
        if (state != NEW ||
            !UNSAFE.compareAndSwapObject(this, runnerOffset,
                                         null, Thread.currentThread()))
            return false;
        boolean ran = false;
        int s = state;
        try {
            Callable<V> c = callable;
            if (c != null && s == NEW) {
                try {
                    c.call(); // don't set result
                    ran = true;
                } catch (Throwable ex) {
                    setException(ex);
                }
            }
        } finally {
            // runner must be non-null until state is settled to
            // prevent concurrent calls to run()
            runner = null;
            // state must be re-read after nulling runner to prevent
            // leaked interrupts
            s = state;
            if (s >= INTERRUPTING)
                handlePossibleCancellationInterrupt(s);
        }
        return ran && s == NEW;
    }

    /**
     * 确保来自cancel(true)的任意中断只有在运行或运行和重置时才能传递给任务
     */
    private void handlePossibleCancellationInterrupt(int s) {
        // It is possible for our interrupter to stall before getting a
        // chance to interrupt us.  Let's spin-wait patiently.
        if (s == INTERRUPTING)
            while (state == INTERRUPTING)
                Thread.yield(); // wait out pending interrupt

        // assert state == INTERRUPTED;

        // We want to clear any interrupt we may have received from
        // cancel(true).  However, it is permissible to use interrupts
        // as an independent mechanism for a task to communicate with
        // its caller, and there is no way to clear only the
        // cancellation interrupt.
        //
        // Thread.interrupted();
    }

    /**
     * 简单的链表节点，用于在Treiber堆栈中记录等待的线程。
     * 请参阅其他类，如Phaser和SynchronousQueue，以获得更详细的解释。
     */
    static final class WaitNode {
        volatile Thread thread;
        volatile WaitNode next;
        WaitNode() { thread = Thread.currentThread(); }
    }

    /**
     * 移除所有等待线程并发出信号，调用done()，置callable为null
     */
    private void finishCompletion() {
        // assert state > COMPLETING;
        for (WaitNode q; (q = waiters) != null;) {
            if (UNSAFE.compareAndSwapObject(this, waitersOffset, q, null)) {
                for (;;) {
                    Thread t = q.thread;
                    if (t != null) {
                        q.thread = null;
                        LockSupport.unpark(t);
                    }
                    WaitNode next = q.next;
                    if (next == null)
                        break;
                    q.next = null; // unlink to help gc
                    q = next;
                }
                break;
            }
        }

        done();

        callable = null;        // to reduce footprint
    }

    /**
     * 在中断或超时时等待完成或中止
     */
    private int awaitDone(boolean timed, long nanos)
        throws InterruptedException {
        final long deadline = timed ? System.nanoTime() + nanos : 0L;
        WaitNode q = null;
        boolean queued = false;
        for (;;) {
            if (Thread.interrupted()) {
                removeWaiter(q);
                throw new InterruptedException();
            }

            int s = state;
            if (s > COMPLETING) {
                if (q != null)
                    q.thread = null;
                return s;
            }
            else if (s == COMPLETING) // cannot time out yet
                Thread.yield();
            else if (q == null)
                q = new WaitNode();
            else if (!queued)
                queued = UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                     q.next = waiters, q);
            else if (timed) {
                nanos = deadline - System.nanoTime();
                if (nanos <= 0L) {
                    removeWaiter(q);
                    return state;
                }
                LockSupport.parkNanos(this, nanos);
            }
            else
                LockSupport.park(this);
        }
    }

    /**
     * 尝试取消链接超时或中断的等待节点，以避免积累垃圾。
     内部节点在没有CAS的情况下是不分割的，因为无论如何释放器都可以遍历到，相对来讲是无害的。
     */
    private void removeWaiter(WaitNode node) {
        if (node != null) {
            node.thread = null;
            retry:
            for (;;) {          // restart on removeWaiter race
                for (WaitNode pred = null, q = waiters, s; q != null; q = s) {
                    s = q.next;
                    if (q.thread != null)
                        pred = q;
                    else if (pred != null) {
                        pred.next = s;
                        if (pred.thread == null) // check for race
                            continue retry;
                    }
                    else if (!UNSAFE.compareAndSwapObject(this, waitersOffset,
                                                          q, s))
                        continue retry;
                }
                break;
            }
        }
    }

    // Unsafe mechanics
    private static final sun.misc.Unsafe UNSAFE;
    private static final long stateOffset;
    private static final long runnerOffset;
    private static final long waitersOffset;
    static {
        try {
            UNSAFE = sun.misc.Unsafe.getUnsafe();
            Class<?> k = FutureTask.class;
            stateOffset = UNSAFE.objectFieldOffset
                (k.getDeclaredField("state"));
            runnerOffset = UNSAFE.objectFieldOffset
                (k.getDeclaredField("runner"));
            waitersOffset = UNSAFE.objectFieldOffset
                (k.getDeclaredField("waiters"));
        } catch (Exception e) {
            throw new Error(e);
        }
    }
}

4.2 FutureTask的使用

可以把FutureTask交给Executor执行；也可以通过 ExecutorService.submit(…) 方法返回一个 FutureTask，然后执行 FutureTask.get() 方法或 FutureTask.cancel(…) 方法。除此以外，还可以单独使用FutureTask。

使用案例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// 创建一个 Callable 对象，返回任务结果
Callable<Integer> callableTask = () -> {
    Thread.sleep(1000);  // 模拟耗时任务
    return 123;
};

// 使用 FutureTask，它实现了 RunnableFuture
RunnableFuture<Integer> futureTask = new FutureTask<>(callableTask);

// 将 FutureTask 提交给线程池执行
ExecutorService executorService = Executors.newSingleThreadExecutor();
executorService.submit(futureTask);

try {
    // 阻塞等待任务执行完成并获取结果
    Integer result = futureTask.get();
    System.out.println("任务结果: " + result);
} catch (InterruptedException | ExecutionException e) {
    e.printStackTrace();
}

executorService.shutdown();

当一个线程需要等待另一个线程把某个任务执行完后它才能继续执行，此时可以使用FutureTask。假设有多个线程执行若干任务，每个任务最多只能被执行一次。当多个线程试图同时执行同一个任务时，只允许一个线程执行任务，其他线程需要等待这个任务执行完后才能继续执行。下面是对应的示例代码。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
private final ConcurrentMap<Object, Future<String>> taskCache = new ConcurrentHashMap<Object, Future<String>>(); 
private String executionTask(final String taskName) throws ExecutionException, InterruptedException {    
    while (true) {        
        Future<String> future = taskCache.get(taskName); // 1.1,2.1        
        if (future == null) {            
            Callable<String> task = new Callable<String>() {                
                public String call() throws InterruptedException {                    
                    return taskName;                
                }            
            };                                                                                     
            FutureTask<String> futureTask = new FutureTask<String>(task);            
            future = taskCache.putIfAbsent(taskName, futureTask);　 // 1.3            
            if (future == null) {                
                future = futureTask;                
                futureTask.run();　// 1.4执行任务            
            }        
        }        
        try {            
            return future.get(); // 1.5,        
        } catch (CancellationException e) {                
            taskCache.remove(taskName, future);        
        }    
    } 
}

上述代码的执行示意图如下图所示。

代码的执行示意图

当两个线程试图同时执行同一个任务时，如果Thread 1执行1.3后Thread 2执行2.1，那么接下来Thread 2将在2.2等待，直到Thread 1执行完1.4后Thread 2才能从2.2（ FutureTask.get() ）返回。

4.3 FutureTask的实现

FutureTask旧版本的实现基于AbstractQueuedSynchronizer（以下简称为AQS）。

java.util.concurrent中的很多可阻塞类（比如ReentrantLock）都是基于AQS来实现的。AQS是一个同步框架，它提供通用机制来原子性管理同步状态、阻塞和唤醒线程，以及维护被阻塞线程的队列。JDK 6中AQS被广泛使用，基于AQS实现的同步器包括：ReentrantLock、Semaphore、ReentrantReadWriteLock、 CountDownLatch和FutureTask。

每一个基于AQS实现的同步器都会包含两种类型的操作，如下。

  • 至少一个acquire操作。这个操作阻塞调用线程，除非/直到AQS的状态允许这个线程继续执行。FutureTask的acquire操作为 get() / get(long timeout，TimeUnit unit) 方法调用。
  • 至少一个release操作。这个操作改变AQS的状态，改变后的状态可允许一个或多个阻塞线程被解除阻塞。FutureTask的release操作包括 run() 方法和 cancel(…) 方法。

基于“复合优先于继承”的原则，FutureTask声明了一个内部私有的继承于AQS的子类Sync，对FutureTask所有公有方法的调用都会委托给这个内部子类。

AQS被作为“模板方法模式”的基础类提供给FutureTask的内部子类Sync，这个内部子类只需要实现状态检查和状态更新的方法即可，这些方法将控制FutureTask的获取和释放操作。具体来说，Sync实现了AQS的 tryAcquireShared(int) 方法和 tryReleaseShared(int) 方法，Sync通过这两个方法来检查和更新同步状态。FutureTask的设计示意图如下图所示。

FutureTask的设计示意图

如图所示，Sync是FutureTask的内部私有类，它继承自AQS。创建FutureTask时会创建内部私有的成员对象Sync，FutureTask所有的的公有方法都直接委托给了内部私有的Sync。

FutureTask.get() 方法会调用 AQS.acquireSharedInterruptibly(int arg) 方法，这个方法的执行过程如下：

  1. 调用 AQS.acquireSharedInterruptibly(int arg) 方法，这个方法首先会回调在子类Sync中实现的 tryAcquireShared() 方法来判断acquire操作是否可以成功。acquire操作可以成功的条件为：state为执行完成状态RAN或已取消状态CANCELLED，且runner不为null。
  2. 如果成功则 get() 方法立即返回。如果失败则到线程等待队列中去等待其他线程执行release操作。
  3. 当其他线程执行release操作（比如 FutureTask.run() 或 FutureTask.cancel(…) ）唤醒当前线程后，当前线程再次执行 tryAcquireShared() 将返回正值1，当前线程将离开线程等待队列并唤醒它的后继线程（这里会产生级联唤醒的效果，后面会介绍）。
  4. 最后返回计算的结果或抛出异常。

FutureTask.run() 的执行过程如下。

  1. 执行在构造函数中指定的任务（ Callable.call() ）。
  2. 以原子方式来更新同步状态（调用 AQS.compareAndSetState(int expect, int update) ，设置state为执行完成状态RUN）。如果这个原子操作成功，就设置代表计算结果的变量result的值为 Callable.call() 的返回值，然后调用 AQS.releaseShared(int arg) 。
  3. AQS.releaseShared(int arg) 首先会回调在子类Sync中实现的 tryReleaseShared(int arg) 来执行release操作（设置运行任务的线程runner为null，然会返回true）；AQS.releaseShared(int arg) ，然后唤醒线程等待队列中的第一个线程。
  4. 调用 FutureTask.done() 。

当执行 FutureTask.get() 方法时，如果FutureTask不是处于执行完成状态RAN或已取消状态CANCELLED，当前执行线程将到AQS的线程等待队列中等待（见下图的线程A、B、C和D）。当某个线程执行 FutureTask.run() 方法或 FutureTask.cancel(...) 方法时，会唤醒线程等待队列的第一个线程（见下图所示的线程E唤醒线程A）：

FutureTask的级联唤醒示意图

假设开始时FutureTask处于未启动状态或已启动状态，等待队列中已经有3个线程（A、B和 C）在等待。此时，线程D执行get()方法将导致线程D也到等待队列中去等待。

当线程E执行run()方法时，会唤醒队列中的第一个线程A。线程A被唤醒后，首先把自己从队列中删除，然后唤醒它的后继线程B，最后线程A从get()方法返回。线程B、C和D重复A线程的处理流程。最终，在队列中等待的所有线程都被级联唤醒并从get()方法返回。

参考：

🔗《Java并发编程的艺术》

相关文章